Public Member Functions | |
| def | AccessibilityFixer (pdf_doc) |
| Constructor. More... | |
| def | CanFixPermissionRules (check_rule, is_ocr_enabled) |
| Check whether permission rules can be fixed. More... | |
| def | CanFixRules (check_rule, check_state) |
| Check whether specified rules can be fixed. More... | |
| def | FixDocumentBookmark (roles_array) |
| Fix document bookmark. More... | |
| def | FixDocumentLanguage (lang) |
| Fix document language. More... | |
| def | FixDocumentPermission () |
| Fix document permission. More... | |
| def | FixDocumentTag () |
| Fix document tag. More... | |
| def | FixDocumentTitle (title, subject, author, keywords) |
| Fix document title. More... | |
| def | FixDocumentTitleWithExistingTitle () |
| Fix document title with existing title. More... | |
| def | FixFigureAltText (detail_data_array) |
| Fix figure alternate text. More... | |
| def | FixFormFieldDescriptions () |
| Fix form field descriptions. More... | |
| def | FixFormFieldTagged () |
| Fix form field tagged. More... | |
| def | FixPageTabOrder () |
| Fix page tab order. More... | |
| def | IsEmpty () |
| Check whether current object is empty or not. More... | |
Detailed Description
This class represents an accessibility fixer for a PDF document: query whether rules are fixable and apply automatic fixes (document language / title / bookmark / permission / tag, page tab order, figure alternate text, form field tagging and descriptions). Before using any class or methods in this module, please ensure Foxit PDF SDK has been initialized successfully by function FoxitPDFSDKPython3.Library.Initialize with a key including "Accessibility" module.
- See also
- FoxitPDFSDKPython3.Library
Constructor & Destructor Documentation
◆ AccessibilityFixer()
| def FoxitPDFSDKPython3.AccessibilityFixer.AccessibilityFixer | ( | pdf_doc | ) |
Constructor.
Constructor, with another fixer object.
- Parameters
-
[in] pdf_doc A valid PDF document object. [in] other Another fixer object.
Member Function Documentation
◆ CanFixPermissionRules()
| def FoxitPDFSDKPython3.AccessibilityFixer.CanFixPermissionRules | ( | check_rule, | |
| is_ocr_enabled | |||
| ) |
Check whether permission rules can be fixed.
- Parameters
-
[in] check_rule The check rule type. [in] is_ocr_enabled Whether OCR is enabled.
- Returns
- true means permission rules can be fixed, while false means not.
◆ CanFixRules()
| def FoxitPDFSDKPython3.AccessibilityFixer.CanFixRules | ( | check_rule, | |
| check_state | |||
| ) |
Check whether specified rules can be fixed.
- Parameters
-
[in] check_rule The check rule type. [in] check_state The check state.
- Returns
- true means the rules can be fixed, while false means not.
◆ FixDocumentBookmark()
| def FoxitPDFSDKPython3.AccessibilityFixer.FixDocumentBookmark | ( | roles_array | ) |
Fix document bookmark.
- Parameters
-
[in] roles_array The roles array.
- Returns
- true means success, while false means not.
◆ FixDocumentLanguage()
| def FoxitPDFSDKPython3.AccessibilityFixer.FixDocumentLanguage | ( | lang | ) |
Fix document language.
- Parameters
-
[in] lang The language to set.
- Returns
- true means success, while false means not.
◆ FixDocumentPermission()
| def FoxitPDFSDKPython3.AccessibilityFixer.FixDocumentPermission | ( | ) |
Fix document permission.
- Returns
- true means success, while false means not.
◆ FixDocumentTag()
| def FoxitPDFSDKPython3.AccessibilityFixer.FixDocumentTag | ( | ) |
Fix document tag.
- Returns
- true means success, while false means not.
◆ FixDocumentTitle()
| def FoxitPDFSDKPython3.AccessibilityFixer.FixDocumentTitle | ( | title, | |
| subject, | |||
| author, | |||
| keywords | |||
| ) |
Fix document title.
- Parameters
-
[in] title The title to set. [in] subject The subject to set. [in] author The author to set. [in] keywords The keywords to set.
- Returns
- true means success, while false means not.
◆ FixDocumentTitleWithExistingTitle()
| def FoxitPDFSDKPython3.AccessibilityFixer.FixDocumentTitleWithExistingTitle | ( | ) |
Fix document title with existing title.
- Returns
- The existing title text.
◆ FixFigureAltText()
| def FoxitPDFSDKPython3.AccessibilityFixer.FixFigureAltText | ( | detail_data_array | ) |
Fix figure alternate text.
- Parameters
-
[in] detail_data_array The check result detail data array.
- Returns
- true means success, while false means not.
◆ FixFormFieldDescriptions()
| def FoxitPDFSDKPython3.AccessibilityFixer.FixFormFieldDescriptions | ( | ) |
Fix form field descriptions.
- Returns
- true means success, while false means not.
◆ FixFormFieldTagged()
| def FoxitPDFSDKPython3.AccessibilityFixer.FixFormFieldTagged | ( | ) |
Fix form field tagged.
- Returns
- true means success, while false means not.
◆ FixPageTabOrder()
| def FoxitPDFSDKPython3.AccessibilityFixer.FixPageTabOrder | ( | ) |
Fix page tab order.
- Returns
- true means success, while false means not.
◆ IsEmpty()
| def FoxitPDFSDKPython3.AccessibilityFixer.IsEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
- Returns
- true means current object is empty, while false means not.
